存在 pyproject.toml 的 Python 项目版本的单一事实来源

Question

pyproject.toml 规范提供了指定项目版本的能力，例如

[project]
name = "foo"
version = "0.0.1"

然而，它也是一个常见的 Python 习惯用法，可以__version__ = "0.0.1"放入foo/__init__.py以便用户查询。

是否有一种标准方法可以version从 中提取pyproject.toml并将其放入 中foo/__init__.py？

Answer 1

您可以在此处采取两种方法。

1. 保留版本pyproject.toml并从源代码中的包元数据中获取它。因此，在您mypkg/__init__.py或任何地方：

   from importlib.metadata import version
   __version__ = version("mypkg")
   

   importlib.metadata.version自 Python 3.8 起可用。对于早期的 Python 版本，您可以使用importlib_metadata向后移植进行类似的操作。

2. 将版本保留在源代码中并指示构建系统从那里获取它。对于 setuptools 构建后端，它看起来像这样pyproject.toml：

   [project]
   name = "mypkg"
   dynamic = ["version"]
   
   [tool.setuptools.dynamic]
   version = {attr = "mypkg.__version__"}
   

我的建议是（）...两者都不是！__version__根本不要在源代码中保留属性。这是一个过时的习惯，现在我们可以不用了。Version已经是包元数据中的必填字段，因此在包/模块命名空间中保留与属性相同的字符串是多余的。