python - 如何在没有 MANIFEST.in 文件的情况下包含 package_data？

Question

如何在没有 MANIFEST.in 文件的情况下为 sdist 包含 package_data？

我的 setup.py 看起来像这样:

import setuptools

setuptools.setup(
    name='foo',
    version='2015.3',
    license='commercial',
    packages=setuptools.find_packages(),

    package_data={'': ['foo/bar.txt']},
)

版本:

user@host> python
Python 2.7.6 (default, Mar 22 2014, 22:59:56) 
>>> import setuptools
>>> setuptools.version.__version__
'3.6'

我就是无法将 foo/bar.txt 包含在内。

或者是this blog post尚真？ http://blog.codekills.net/2011/07/15/lies,-more-lies-and-python-packaging-documentation-on--package_data-/

不过，在过去的一个小时里，我了解到这些陈述介于“危险的误导”和“该死的谎言”之间。这是因为 Python 包的主要类型是源码包，而创建源码包的规范方法是使用 setup.py sdist。但是，在 package_data 中指定的数据不包含在源代码分发中——它们只包含在二进制 (setup.py bdist) 分发和安装 (setup.py install) 中。

如何在没有 MANIFEST.in 文件的情况下为 sdist 包含 package_data？

Answer 1

TL;DR:package_data 字典中的键是packages；这些值是 glob 列表。 '' 不是任何 Python 包的有效名称。

如果你想让 bar.txt 安装在 foo 包的 __init__.py 旁边，请使用

 package_data={'foo': ['bar.txt']}

---

我有布局:

foo/
        __init__.py
        bar.txt
setup.py

现在，如果 foo 是像上面这样的包，那么:

import setuptools

setuptools.setup(
    name='foo',
    version='2015.3',
    license='commercial',
    packages=setuptools.find_packages(),
    package_data={'foo': ['bar.txt']},
)

在python setup.py sdist之后，我检查dist/foo-2015.3.tar.gz

的内容

% tar tfz dist/foo-2015.3.tar.gz
...
foo-2015.3/foo/bar.txt
...

但是，如果我使用 package_data={'': ['foo/bar.txt']} 运行您的 setup.py，我可以同意 foo/bar.txt 将不会添加到源代码分发中，除非 foo-2015.3.egg-info/SOURCES.txt 已经有 foo/bar.txt 的行 - 在这种情况下，该文件也会在源代码分发中弹出

没有使用 list ； setuptools 版本是 3.6(我故意安装了与您使用的相同的旧版本):

>>> import setuptools
>>> setuptools.__version__
'3.6'

---

上述行为也适用于标准 distutils:2.6 Installing package data “遗留”的 distutils 文档；对 2.7、3.1 发表评论:

Changed in version [2.7, 3.1]: All the files that match package_data will be added to the MANIFEST file if no template is provided.