setup.cfg 的元数据中的 "version" 条目被忽略

Question

我想写一个新的 Python 包，我想通过 PyPI 提供它。过去我总是使用setup.py。但这次我决定拥抱新的使用 setup.cfg 的最佳实践反而。所以我开始阅读一点文档，主要是 https://setuptools.pypa.io/en/latest/userguide/declarative_config.html.

我还决定使用 pyscaffold 来生成文件。 pyscaffold 为我生成了一个 setup.cfg 文件，我添加了（仅用于测试目的）version = 5.1.1 在 metadata 部分下，如上面的文档。

为了方便起见，我正在使用 anaconda 并创建了一个新的空环境：

$ python --version
Python 3.9.7
$  pip list
...
PyScaffold                    4.1.1
setuptools                    58.4.0
setuptools-scm                6.3.2
wheel                         0.37.0

但是当我执行pip install -e .时，版本被忽略并且pip分配了一个不同的：

$ pip install -e .
Obtaining file:///tmp/test_package
  Installing build dependencies ... done
  Checking if build backend supports build_editable ... done
  Getting requirements to build wheel ... done
  Preparing metadata (pyproject.toml) ... done
Installing collected packages: test-package
  Attempting uninstall: test-package
    Found existing installation: test-package 0.0.post1.dev10+g3ed39c8.d20211106
    Uninstalling test-package-0.0.post1.dev10+g3ed39c8.d20211106:
      Successfully uninstalled test-package-0.0.post1.dev10+g3ed39c8.d20211106
  Running setup.py develop for test-package
Successfully installed test-package-0.0.post1.dev1+g228b46c

提到 setuptools 版本 30.3.0支持把metadata放在setup.cfg，我用的是58.4.0，这么多更新版本。

我也用 version = file:VERSION.txt 等不同的格式进行了测试，但是也没有帮助，pip 只是忽略了 version 条目。

我错过了什么？我做错了什么？

我用这些文件准备了一个小的 git 回购协议，以便能够重现错误：https://github.com/shaoran/test_package 有没有人得到不同的结果？

Answer 1

那是因为 pyscaffold 生成了一个使用 setuptools-scm 进行版本检测的项目。当使用 setuptools-scm 时，版本不是从 version 元数据中读取的，而是从存储库标签中解析的。版本0.0.post1.dev10+g3ed39c8.d20211106可以这样读：

0.0.post1 - 虚拟版本，因为你在 repo 中还没有任何标签；
dev10 - 您有 10 个未包含在任何版本标记中的提交（基本上是自上次标记以来您所做的提交数量）；
g3ed39c8 - 您安装的提交的短哈希是 3ed39c8（前缀 g 表示它是 Git 回购）；
d20211106 - d 表示您是从脏状态安装的（某些由 Git 版本化的文件已被修改），其余只是时间戳。

如果您想使用 setup.cfg 中的版本元数据，只需在 setup.py 中删除 setuptools-scm 激活：

if __name__ == "__main__":
    try:
        setup()
    except:
        ...

您还可以清理 pyproject.toml，尽管这不是明确要求的：

[build-system]
requires = ["setuptools>=46.1.0", "wheel"]
build-backend = "setuptools.build_meta"

如果您想继续使用 setuptools-scm（IMO 是防止您意外发布具有相同版本但内容不同的 dists 的好工具），那么只需添加一个新标签即可开始版本控制：

$ git tag -a 5.1.1 -m 'start versioning'

如果你有一个干净的 repo 状态（没有修改的文件），pip install -e . 将立即安装版本 5.1.1。否则，您将获得带有后缀的 5.1.1。

使用 setuptools-scm 的巧妙之处在于 setup.cfg 中的版本元数据被忽略，因此您不必自己修改它并且可以安全地删除 version = 5.1.1 行。

setup.cfg 的元数据中的 "version" 条目被忽略

The "version" entry in the metadata of setup.cfg is being ignored

python

pip

setuptools