Почему "python setup.py sdist" создание нежелательных "PROJECT-egg.info-в корневом каталоге проекта?
когда я запускаю
python setup.py sdist
Он создает sdist в my .каталог /дист. Это включает в себя "PROJECT-egg.info" файл в zip внутри моей папки" dist", которую я не использую, но мне не больно, поэтому я просто игнорирую его.
мой вопрос в том, почему это и создать "PROJECT-egg.info" папка в моем корневом каталоге проекта? Могу ли я сделать так, чтобы это прекратилось? Если нет, Могу ли я просто удалить его сразу после создания sdist?
Я использую функция "setup" импортирована из setuptools. WindowsXP, Python2.7, Setuptools 0.6c11, распределить 0.6.14.
моя настройка конфигурации выглядит так:
{'author': 'Jonathan Hartley',
'author_email': 'tartley@tartley.com',
'classifiers': ['Development Status :: 1 - Planning',
'Intended Audience :: Developers',
'License :: OSI Approved :: BSD License',
'Operating System :: Microsoft :: Windows',
'Programming Language :: Python :: 2.7'],
'console': [{'script': 'demo.py'}],
'data_files': [('Microsoft.VC90.CRT',
['..libMicrosoft.VC90.CRTMicrosoft.VC90.CRT.manifest',
'..libMicrosoft.VC90.CRTmsvcr90.dll'])],
'description': 'Utilities for games and OpenGL graphics, built around Pyglet.n',
'keywords': '',
'license': 'BSD',
'long_description': "blah blah blah",
'name': 'pygpen',
'options': {'py2exe': {'ascii': True,
'bundle_files': 1,
'dist_dir': 'dist/pygpen-0.1-windows',
'dll_excludes': [],
'excludes': ['_imaging_gif',
'_scproxy',
'clr',
'dummy.Process',
'email',
'email.base64mime',
'email.utils',
'email.Utils',
'ICCProfile',
'Image',
'IronPythonConsole',
'modes.editingmodes',
'startup',
'System',
'System.Windows.Forms.Clipboard',
'_hashlib',
'_imaging',
'_multiprocessing',
'_ssl',
'_socket',
'bz2',
'pyexpat',
'pyreadline',
'select',
'win32api',
'win32pipe',
'calendar',
'cookielib',
'difflib',
'doctest',
'locale',
'optparse',
'pdb',
'pickle',
'pyglet.window.xlib',
'pyglet.window.carbon',
'pyglet.window.carbon.constants',
'pyglet.window.carbon.types',
'subprocess',
'tarfile',
'threading',
'unittest',
'urllib',
'urllib2',
'win32con',
'zipfile'],
'optimize': 2}},
'packages': ['pygpen'],
'scripts': ['demo.py'],
'url': 'http://code.google.com/p/edpath/',
'version': '0.1',
'zipfile': None}
4 ответов
этот каталог создается намеренно в процессе сборки исходного дистрибутива. Немного поглазеть на руководство разработчика для setuptools дает вам подсказку о том, почему:
но, обязательно игнорируйте любую часть distutils документации, предложения с помощью MANIFEST или как он генерируется из манифеста.в; setuptools щиты вы от этих вопросов и не работает во всяком случае, так же. В отличие от distutils, setuptools регенерирует файл манифеста исходного распространения каждый раз, когда вы создаете источник распространение, и оно строит его внутри проект. egg-info каталог, out пути вашего основного проекта справочник. Поэтому вам не нужно беспокойтесь о том, является ли он современным или нет.
вы можете безопасно удалить каталог после завершения сборки.
бонус редактирования:
настроить в моем setup.py на многих моих проектах Python для удаления *.egg-info, dist, build и *.pyc и другие файлы. Вот пример того, как это делается в setup.py:
import os
from setuptools import setup, Command
class CleanCommand(Command):
"""Custom clean command to tidy up the project root."""
user_options = []
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
os.system('rm -vrf ./build ./dist ./*.pyc ./*.tgz ./*.egg-info')
# Further down when you call setup()
setup(
# ... Other setup options
cmdclass={
'clean': CleanCommand,
}
)
чтобы проиллюстрировать, после запуска python setup.py build на фиктивном проекте под названием " какашки "(Да, я очень зрелый), это происходит:
$ python setup.py build
running build
running build_py
creating build
creating build/lib
creating build/lib/poop
copying poop/__init__.py -> build/lib/poop
а теперь, если мы побежим python setup.py clean:
$ python setup.py clean
running clean
removed `./build/lib/poop/__init__.py'
removed directory: `./build/lib/poop'
removed directory: `./build/lib'
removed directory: `./build'
Тада!
на -egg.info папка не всегда является временным артефактом, который можно удалить.
например, если вы используете pip install -e YOURPACKAGE для" редактируемой " установки (работает через символическую ссылку, как python setup.py develop таким образом, вам не нужно повторно устанавливать пакет каждый раз, когда вы редактируете его локально),-egg.info папка требуется во время выполнения, когда ваш пакет импортируется в другой источник. Если он не существует, вы получите DistributionNotFound ошибка.
обратите внимание, что вы можете иметь PROJECT.egg-info артефакты полностью исчезают из вашего sdist.
команда setup.py egg_info будет использовать исходный корень в качестве основы яйца по умолчанию, в результате чего PROJECT.egg-info каталог упаковывается в sdist.
вы можете настроить базу яиц, передав опцию --egg-base.
Это создаст PROJECT.egg-info каталог где-то еще, полностью оставив его вне вашего исходного дистрибутива. Вы также можете использовать setup.cfg установить, что свойство.
следующая команда для создания sdist без PROJECT.egg-info у меня работает:
python setup.py egg_info --egg-base /tmp sdist
или setup.cfg:
[egg_info]
egg_base = /tmp
система упаковки и сборки Pythons сломана imho. Таким образом, есть много хаков и обходных путей для вещей, которые можно было бы считать работой из коробки.
однако," самый чистый " хак, который я нашел для удаления *.egg-info использует нормальный clean --all переключатель вместе с egg_info поставить *.файл egg-info в подпапке, который будет очищен командой clean. Вот пример:
в своем setup.cfg использовать что-то вроде этого:
[egg_info]
egg_base = ./build/lib
где ./build/lib - Это папка, которая clean --all будет удалить. Затем при создании проекта с помощью setuptools используйте команду clean с флагом --all, например
python setup.py bdist_wheel clean --all
если вы хотите создать исходный пакет, просто убедитесь, что вы создали bdist_wheel перед sdist, поэтому папка build/lib существует, например:
python setup.py bdist_wheel sdist clean --all