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

在本文中，我们将介绍如何在没有 MANIFEST.in 文件的情况下，通过使用 setup.py 方法来包含 package_data。

在使用 Python 开发项目时，有时我们需要将一些非 Python 源代码文件或其他资源文件包含在我们的软件包中。这些文件可以是配置文件、模板、静态资源等等。对于这些需要包含的文件，我们可以通过 MANIFEST.in 文件来指定，然后使用python setup.py sdist命令打包软件包时自动包含进去。但是，有时候我们可能不想使用 MANIFEST.in 文件，而是更希望在 setup.py 中指定要包含的文件列表。

幸运的是，Python 提供了一种简单的方法来实现这一点，即使用 package_data 参数。package_data 是一个字典，用于指定要包含在软件包中的文件。键是包名，值是文件或文件列表的通配符。我们可以在 setup.py 文件中直接设置package_data，而不需要创建 MANIFEST.in 文件。

下面是一个示例，展示了如何在没有 MANIFEST.in 文件的情况下使用 package_data 来包含文件：

from setuptools import setup, find_packages

setup(
    name="my_package",
    version="1.0",
    packages=find_packages(),
    package_data={
        "my_package": ["templates/*.html", "static/css/*.css"]
    },
)

在这个示例中，我们假设我们的软件包名为 my_package，并且我们想要包含 templates 目录下的所有 .html 文件和 static/css 目录下的所有 .css 文件。通过设置 package_data 参数，我们可以指定这些要包含的文件。在这个例子中，我们将它们添加到 my_package 包中。

运行 python setup.py sdist 命令来打包软件包时，我们会发现在生成的压缩包中包含了我们指定的文件。通过这种方式，我们不需要创建 MANIFEST.in 文件，而是使用了更直观的方式在 setup.py 中指定要包含的文件。

需要注意的是，当我们使用 package_data 参数时，找到的文件列表是相对于包目录的，而不是相对于 setup.py 文件所在目录的。因此，我们需要确保路径是相对于包目录的正确路径。

另外，我们还可以使用通配符来指定要包含的文件。例如，package_data={"my_package": ["templates/*.html"]} 将包含 templates 目录下的所有 .html 文件。

阅读更多：Python 教程

总结

在本文中，我们介绍了如何在没有 MANIFEST.in 文件的情况下使用 setup.py 方法来包含 package_data。通过设置 package_data 参数，我们可以指定要包含的非 Python 源代码文件或其他资源文件。这种方式更加直观和方便，不需要创建额外的 MANIFEST.in 文件。希望本文对你在包含 package_data 方面的工作有所帮助。