如何使用 setup.cfg 将数据放入 Python 包中

Question

我正在尝试创建一个包含数据文件的包，但它不起作用。

我的 setup.cfg （每个链接）如下。

[metadata]
name = my_package
version = 1.0.0
description = My package description
author = John Henckel
author_email = henckel.jonathan@mayo.edu
url = http://example.com
keywords = one, two
license = BSD 3-Clause License
classifiers =
    Framework :: Django
    License :: OSI Approved :: BSD License
    Programming Language :: Python :: 3
    Programming Language :: Python :: 3.5

[options]
include_package_data = True
packages = find:

[options.package_data]
* = *.txt

我的项目的目录结构是...

LICENSE
pyproject.toml
README.md
setup.cfg
my_package
    hello.txt
    __init__.py

我输入...

python -m build --sdist
tar -vtf dist/my_package-1.0.0.tar.gz

正如您所看到的，输出不包含hello.txt. 为什么不！？？

drwxrwxrwx  0 0      0           0 Oct 22 17:28 my_package-1.0.0/
-rw-rw-rw-  0 0      0          48 Oct 22 17:24 my_package-1.0.0/LICENSE
-rw-rw-rw-  0 0      0         474 Oct 22 17:28 my_package-1.0.0/PKG-INFO
-rw-rw-rw-  0 0      0          29 Oct 22 17:24 my_package-1.0.0/README.md
drwxrwxrwx  0 0      0           0 Oct 22 17:28 my_package-1.0.0/my_package/
-rw-rw-rw-  0 0      0           0 Oct 22 17:24 my_package-1.0.0/my_package/__init__.py
drwxrwxrwx  0 0      0           0 Oct 22 17:28 my_package-1.0.0/my_package.egg-info/
-rw-rw-rw-  0 0      0         474 Oct 22 17:28 my_package-1.0.0/my_package.egg-info/PKG-INFO
-rw-rw-rw-  0 0      0         201 Oct 22 17:28 my_package-1.0.0/my_package.egg-info/SOURCES.txt
-rw-rw-rw-  0 0      0           1 Oct 22 17:28 my_package-1.0.0/my_package.egg-info/dependency_links.txt
-rw-rw-rw-  0 0      0          11 Oct 22 17:28 my_package-1.0.0/my_package.egg-info/top_level.txt
-rw-rw-rw-  0 0      0         108 Oct 01 13:52 my_package-1.0.0/pyproject.toml
-rw-rw-rw-  0 0      0         528 Oct 22 17:28 my_package-1.0.0/setup.cfg

Answer 1

我怀疑这可能取决于您安装的安装工具版本。当我使用相同的 构建您的包的测试版本时setup.cfg，我的源发行版包含hello.txt. 但是，您可能还想尝试include_package_data = True从 中删除该选项setup.cfg。最新的setuptools 用户指南如下：

“总而言之，这三个选项允许您：

• include_package_data 接受 MANIFEST.in 匹配的所有数据文件和目录。
• package_data指定其他模式来匹配 MANIFEST.in 可能匹配或不匹配的文件或在源代码管理中找到的文件。
• exclude_package_data指定安装包时不应包含的数据文件和目录的模式，即使由于使用前述选项而本来会包含它们。”

setuptools对于某些版本的，该选项可能include_package_data会覆盖该package_data列表，因此您必须提供一个MANIFEST.in文件。

编辑：我忽略了 setuptools 用户指南中的这条语句，这似乎证实了我上面写的内容：

“如果使用 setuptools 特定的include_package_data参数，package_data 指定的文件将不会自动添加到清单中，除非它们在 MANIFEST.in 文件中列出。”