为什么"python setup.py sdist"会在项目根目录中创建不需要的"PROJECT-egg.info"？

Question

我跑的时候

  python setup.py sdist

它在我的./dist目录中创建了一个sdist.这包括我的"dist"文件夹中的zip中的"PROJECT-egg.info"文件,我没有使用它,但它不会伤害我,所以我只是忽略它.

我的问题是,为什么它也建立在我的项目根目录下的"PROJECT-egg.info"文件夹？我可以让它停止创建吗？如果没有,我可以在创建sdist后立即删除它吗？

我正在使用从setuptools导入的'setup'功能.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',
                 ['..\\lib\\Microsoft.VC90.CRT\\Microsoft.VC90.CRT.manifest',
                  '..\\lib\\Microsoft.VC90.CRT\\msvcr90.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}

Answer 1

此目录是作为源分发的构建过程的一部分有意创建的.在setuptools的开发人员指南中有一点关于为您提供以下原因的提示:

但是,请务必忽略处理MANIFEST的distutils文档的任何部分或者如何从MANIFEST.in生成; setuptools保护您免受这些问题的影响,并且在任何情况下都不会以相同的方式工作.与distutils不同,setuptools每次构建源代码分发时都会重新生成源代码分发清单文件,并在项目的.egg-info目录中构建它,不受主项目目录的影响.因此,您无需担心它是否是最新的.

您可以在构建完成后安全地删除该目录.

奖金编辑:

我定制clean我的内命令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一个名为"poop"的虚拟项目后(是的,我非常成熟),会发生这种情况:

$ 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'

田田!

Answer 2

该-egg.info文件夹并不总是您可以删除的临时工件.

例如,如果您使用pip install -e YOURPACKAGE"可编辑"安装(通过符号链接工作,python setup.py develop因此每次在本地编辑时都不必重新安装包),-egg.info当您的包导入另一个包时,在运行时需要该文件夹资源.如果它不存在,您将收到DistributionNotFound错误.

Answer 3

请注意,您可以PROJECT.egg-info从您的sdist中完全消失这些工件.

setup.py egg_info默认情况下,该命令将使用源根作为egg base,从而将PROJECT.egg-info目录打包到sdist中.

您可以通过传递选项配置蛋基--egg-base.这将在PROJECT.egg-info其他地方创建目录,使其完全脱离源代码分发.您也可以使用a setup.cfg来设置该属性.

以下命令创建一个没有PROJECT.egg-info为我工作的sdist :

python setup.py egg_info --egg-base /tmp sdist

或者在setup.cfg:

[egg_info]
egg_base = /tmp

Answer 4

恕我直言，Python 的打包和构建系统已损坏。因此，对于人们认为开箱即用的事情，有许多技巧和变通方法。

但是，我发现删除 *.egg-info 的“最干净”黑客是使用普通clean --all开关以及egg_info将 *.egg-info 文件放在一个子文件夹中，该子文件夹将由 clean 命令清除。这里有一个例子：

在你的setup.cfg使用中是这样的：

[egg_info]
egg_base = ./build/lib

将删除./build/lib的文件夹在哪里clean --all。然后在使用 setuptools 构建项目时，使用带有 --all 标志的 clean 命令，例如

python setup.py bdist_wheel clean --all

如果您还想构建一个源包，只需确保在 sdist 之前构建 bdist_wheel 以便 build/lib 文件夹存在，例如：

python setup.py bdist_wheel sdist clean --all