为什么“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': '[email protected]',
 '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 开发人员指南，您就会得到以下提示：为什么：

但是，请务必忽略其中的任何部分
distutils 文档处理
与 MANIFEST 或它的生成方式
来自 MANIFEST.in；安装工具盾牌
你免受这些问题的困扰，但不起作用
无论如何都以同样的方式。与
distutils、setuptools 重新生成
源分发清单文件
每次构建源代码时
分布，并在内部构建它
项目的 .egg-info 目录，out
你的主要项目的方式
目录。因此您无需
担心它是否是最新的
或不。

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

额外编辑：

我在许多 Python 项目的 setup.py 中自定义了 clean 命令来删除 *.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,
    }
)

为了说明这一点，在一个名为“poop”的虚拟项目上运行 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'

Tada！

Answer 2

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

例如，如果您使用 pip install -e YOURPACKAGE 进行“可编辑”安装（通过像 python setup.pydevelop 这样的符号链接工作，因此您不必重新安装每次在本地编辑包时都会安装一个包），当您的包导入到另一个源中时，运行时需要 -egg.info 文件夹。如果它不存在，您将收到 DistributionNotFound 错误。

Answer 3

请注意，您可以让 PROJECT.egg-info 工件从您的 sdist 中完全消失。

命令 setup.py Egg_info 默认情况下将使用源根目录作为 Egg 库，从而将 PROJECT.egg-info 目录打包到 sdist 中。

您可以通过传递选项--egg-base来配置egg基础。
这将在其他位置创建 PROJECT.egg-info 目录，将其完全排除在源代码发行版之外。您还可以使用 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

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

python setup.py bdist_wheel sdist clean --all

Answer 5

jathanism 的方法可能是使用 egg_info 钩子。我用它在每次构建之前进行清理：

from pathlib import Path
from setuptools import setup
from setuptools.command.egg_info import egg_info

here = Path(__file__).parent.resolve()

class CleanEggInfo(egg_info):
    def run(self):
       shutil.rmtree(here.joinpath('build'), ignore_errors=True)
       shutil.rmtree(here.joinpath('dist'), ignore_errors=True)

        for d in here.glob('*.egg-info'):
            shutil.rmtree(d, ignore_errors=True)

        egg_info.run(self)

setup(
    cmdclass={
        'egg_info': CleanEggInfo,
    }
)