时间戳

首页 > 解决方案 > 在 setup.py 中包含根级别的文件

python - 在 setup.py 中包含根级别的文件

问题描述

我正在尝试在我们的工作环境中使用竹管道构建一个 python 包。

要触发构建，我必须包含一个build.info.txt包含版本号的文件。该文件位于存储库的顶层，因此存储库结构如下

build.info.txt
setup.py
MANIFEST.in
README.md
package/
   __init__.py
   file1.py
   file2.py

文件build.info.txt有版本号

version=x.y.z

我想使用这个文件来触发版本号，因此在__init__.py我包含了一个简单的解析器

from pathlib import Path
path = Path(__file__).absolute().parent / "build.info.txt"
__version__ = open(path).readline()[0].split("=")[-1]

这在本地模式下工作正常。但是，当我创建一个包并将其推送到我们的 pypi 服务器时，我在运行时收到以下错误（即pip install package有效）：

FileNotFoundError: [Errno 2] No such file or directory: '</PATH/TO/ENVIRONMENT>/python3.8/site-packages/build.info.txt'

我改变了setup.py（我使用setuptools）的行为，包括：

setup(**other_params, package_data={"": ["../build.info.txt"]}, include_package_data=True)

虽然MANIFEST.in看起来像

include build.info.txt

问题是build.info.txtusingpip install位于顶层：

</PATH/TO/ENVIRONMENT>/python3.8/site-packages/build.info.txt

这个文件在几个包之间共享，而我想把这个文件放在

</PATH/TO/ENVIRONMENT>/python3.8/site-packages/<PACKAGE>/build.info.txt

（然后我必须管理解析器__init__才能解析正确的文件，但这很简单）

我该如何管理？

谢谢

标签： pythonsetuptools

解决方案

我的建议是用来importlib.metadata阅读项目的版本。

曾试图将PEP 396__version__中的设置约定形式化和标准化，但从未完全接受。而且现在这种习惯也消失了，因为对它的需求不再那么紧迫，这要归功于. 因此，您可以完全删除想要知道您的应用程序或库的版本号的第 3 方代码片段可以用来读取它。importlib.metadata__version__importlib.metadata.version('MyProject')

如果您坚持__version__在您的图书馆中拥有，您可以扭转这一点并在您的__init__.py:

__version__ = importlib.metadata.version('MyProject')

旁白：

  • 如果您坚持使用该文件build-info.txt，那么您可以在包中对其进行符号链接，例如package/build-info.txt（链接到build-info.txt），并且__init__.py可以在运行时读取该文件。

    • 或者，如评论中所建议的，符号链接build-info.txt到package/build_info.py, 和__init__.py: from build_info import version as __version__（这假设该文件的内容也是有效的 Python 语法）。

  • 您不应该使用__file__来读取包数据资源，这是不可靠的，importlib.resources请改用（它将以更简洁的方式执行此操作，并且如果需要，请注意提取文件以防压缩包等）。

  • 有一些工具可以处理所有这些版本号问题，setuptools-scm想到并可能满足您的需求。

推荐阅读