如何让 setuptools 忽略 subversion inventory？

Question

当使用 setuptools 的 setup.py 打包 Python 包时：

from setuptools import setup
...

创建的源代码发行版：

python setup.py sdist

不仅像往常一样包括 MANIFEST.in 中指定的文件，而且还无偿地包括 Subversion 列出的所有文件作为包目录下的版本控制。 这非常烦人。 这不仅使得对随我的包分发哪些文件进行任何类型的显式控制变得困难，而且这意味着当我按照“svn导出”而不是“svn签出”构建我的包时，我的包的内容包可能会完全不同，因为如果没有 .svn 元数据，安装工具将对要包含的内容做出不同的选择。

我的问题：我怎样才能关闭这种可怕的行为，以便“setuptools”以同样的方式对待我的项目，无论我使用的是Subversion，还是从未听说过的版本控制，或者是使用我使用的“svn导出”创建的裸树在我的项目结束时创建，以确保它在我的工作目录之外的某个地方干净地构建？

到目前为止，我做得最好的是一个丑陋的猴子补丁：

from setuptools.command import sdist
del sdist.finders[:]

但这是Python，而不是丛林，所以我当然想要一个完全不涉及猴子的更好的解决方案。 我怎样才能驯服 setuptools，关闭它的魔力，并通过查看 MANIFEST.py 中可见的、可预测的规则让它表现得明智？

Answer 1

我知道你对此了解很多，布兰登，但为了其他人的利益，我会尽力给出完整的答案（尽管我不是安装工具专家）。

这里的问题是 setuptools 本身涉及相当多的黑魔法，包括使用名为 setuptools.file_finders 的入口点，您可以在其中添加插件来查找要包含的文件。 然而，我完全不知道如何从中删除插件...

• 快速解决方法：svn 将包导出到临时目录并从那里运行 setup.py。 这意味着您没有 svn，因此 svn finder 找不到要包含的文件。 :)

• 更长的解决方法：你真的需要安装工具吗？ setuptools 有很多功能，所以答案可能是肯定的，但这些功能主要是依赖项（因此您的依赖项通过 easy_install 安装）、命名空间包 (foo.bar) 和入口点。 实际上也可以在没有 setuptools 的情况下创建命名空间包。 但如果你不使用这些，你实际上可能只使用 distutils 就可以逃脱惩罚。

• 丑陋的解决方法：您在问题中给 sdist 的 Monkeypatch，这只会使插件没有任何查找器，并快速退出。

  丑陋的解决方法：

正如你所看到的，这个答案虽然我能做到的很完整，但仍然是令人尴尬的不完整。 我实际上无法回答你的问题，尽管我认为答案是“你不能”。

Answer 2

创建 MANIFEST.in 文件：

recursive-exclude .
# other MANIFEST.in commands go here
# to explicitly include whatever files you want

请参阅 http://docs.python.org/ distutils/commandref.html#sdist-cmd 用于 MANIFEST.in 语法。

Answer 3

简单的解决方案，不要使用 setuptools 来创建源代码分发，针对该命令降级到 distutils：

from distutils.command.sdist import sdist
from setuptools import setup

setup(
    # ... all the usual setup arguments ...
    cmdclass = {'sdist': sdist},
)

Answer 4

也许答案就在你的 setup.py 中。 你使用find_packages吗？ 该函数默认使用VCS（例如subversion、hg...）。 如果你不喜欢它，只需编写一个不同的 Python 函数，它只收集你想要的东西。

Answer 5

我认为默认的 sdist 行为是正确的。 当您构建源代码发行版时，我希望它包含签入 Subversion 的所有内容。 当然，如果能够在特殊情况下干净地覆盖它那就太好了。

比较 sdist 和 bdist_egg； 我敢打赌，只有明确指定的文件才会被包含在内。

我用三个文件做了一个简单的测试，都在 svn 中。 清空 dummy.lkj 和 foobar.py，setup.py 如下所示：

import setuptools
setuptools.setup(name='foobar', version='0.1', py_modules=['foobar'])

sdist 创建一个包含 dummy.lkj 的 tarball。 bdist_egg 创建一个不包含 dummy.lkj 的 Egg。

Answer 6

你可能想要这样的东西：

from distutils.core import setup

def packages():
    import os

    packages = []

    for path, dirs, files in os.walk("yourprogram"):
        if ".svn" in dirs:
            dirs.remove(".svn")

        if "__init__.py" in files:
            packages.append(path.replace(os.sep, "."))

    return packages

setup(
    # name, version, description, etc...

    packages = packages(),

    # pacakge_data, data_files, etc...
)