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

Posted 2023-02-18

【中文标题】如何在没有 MANIFEST.in 文件的情况下包含 package_data？

【英文标题】：How can I include package_data without a MANIFEST.in file?

【发布时间】：2015-05-16 05:06:27

【问题描述】：

如何在没有 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？

【参考方案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 的行 - 在这种情况下，文件也会在源代码分发中弹出

没有使用清单； setuptools 版本是3.6（我故意安装了与您使用的相同的旧版本）：

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

---

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

在版本中更改[2.7, 3.1]：如果没有提供模板，所有匹配 package_data 的文件都将添加到 MANIFEST 文件中。

【讨论】：

感谢您的详细回答。不幸的是，我只是逐字按照这些说明进行操作，bar.txt 未能出现在foo-2015.3.tar.gz 中。您提到故意使用旧版本的 setuptools，但您没有说明原因。这能解释为什么它不起作用吗？

这个答案并不完全正确。空字符串'' 是适用于所有包的特殊键，如here 中所述：请注意，如果您在空字符串下的 package_data 中列出模式，则这些模式用于在每个包中查找文件，即使那些也有列出了他们自己的模式。

【参考方案2】：

我遇到了同样的问题并修复它正在删除：

include_package_data=True

【讨论】：

这也为我解决了问题。

有人能解释一下原因吗？

这里的顶部条目解释了这一点：setuptools.readthedocs.io/en/latest/…

@AdamErickson 不是吗？

查看jwodder.github.io/kbits/posts/pypkg-data/… 中的警告：setuptools.pypa.io/en/latest/userguide/… 说“数据文件必须通过 distutils 的 MANIFEST.in 文件指定。”，没有足够强调 必须.