使用 versioneer 和 GitHub 更新版本号

Question

我正在为几个 GitHub 托管的 Python 项目使用versioneer 。 似乎安装了 versioneer 并且工作正常，我可以调用project.__version__ 。

但是，我忘记了如何更新版本号的过程。 setup.cfg或setup.py中的任何内容都应该保持不变吗？

控制版本号的只有git tag命令吗？ 如果我使用 GitHub 的“起草新版本”，Python/versioneer 版本号会自动更新吗？ GitHub 的发布是最好的方式，还是我应该在本地发布，例如git tag v0.2 ？ 我想这无关紧要？

Answer 1

是的， versioneer将从您的存储库的 git 标签 + state 获取版本号。 无需修改您的安装文件（或 .py版本）。 （这就是版本控制的美妙之处。）

Oleksandr 链接到的文档包含所有内容（ https://github.com/python-versioneer/python-versioneer/blob/master/INSTALL.md ）

例如，如果您刚刚将 repo 标记为v1.0 ，您的代码版本（例如， import mylib; print(mylib.__version__) ，或来自终端的python setup.py version ）将显示干净的v1.0 。

如果您碰巧修改和/或提交了某些内容，版本将相应更新。 在下面，我的一个回购协议的当前 state：一次提交，加上未提交的更改，在“v1.1”标签之上，

$ python setup.py version

/opt/miniconda3/envs/osh_devel/lib/python3.10/site-packages/setuptools/dist.py:506: UserWarning: Normalizing 'v1.1+1.g106ac16.dirty' to '1.1+1.g106ac16.dirty'
  warnings.warn(tmpl.format(**locals()))
running version
keywords are unexpanded, not using
got version from VCS {'version': 'v1.1+1.g106ac16.dirty', 'full-revisionid': '106ac1638a9a789fa8bdb6df42a608985b18e88c', 'dirty': True, 'error': None, 'date': '2022-03-25T17:01:46+0100'}
Version: v1.1+1.g106ac16.dirty
 full-revisionid: 106ac1638a9a789fa8bdb6df42a608985b18e88c
 dirty: True
 date: 2022-03-25T17:01:46+0100

---

关于 PyPI 和pyproject.toml注意事项

将pyproject.toml文件添加到我的库后，versioneer 停止工作，每当我尝试（开发）安装时都会在下面删除错误消息：

$ pip install -e .

Obtaining file:///Users/chbrandt/Coisas/repos/stuff/osh
  Installing build dependencies ... done
  Checking if build backend supports build_editable ... done
  Getting requirements to build wheel ... error
  error: subprocess-exited-with-error
  
  × Getting requirements to build wheel did not run successfully.
  │ exit code: 1
  ╰─> [16 lines of output]
      Traceback (most recent call last):
        File "/opt/miniconda3/envs/osh_devel/lib/python3.10/site-packages/pip/_vendor/pep517/in_process/_in_process.py", line 363, in <module>
          main()
        File "/opt/miniconda3/envs/osh_devel/lib/python3.10/site-packages/pip/_vendor/pep517/in_process/_in_process.py", line 345, in main
          json_out['return_val'] = hook(**hook_input['kwargs'])
        File "/opt/miniconda3/envs/osh_devel/lib/python3.10/site-packages/pip/_vendor/pep517/in_process/_in_process.py", line 130, in get_requires_for_build_wheel
          return hook(config_settings)
        File "/private/var/folders/b1/frq3gywj3ljfqrf1yc7zk06r0000gn/T/pip-build-env-6kvnzo67/overlay/lib/python3.10/site-packages/setuptools/build_meta.py", line 177, in get_requires_for_build_wheel
          return self._get_build_requires(
        File "/private/var/folders/b1/frq3gywj3ljfqrf1yc7zk06r0000gn/T/pip-build-env-6kvnzo67/overlay/lib/python3.10/site-packages/setuptools/build_meta.py", line 159, in _get_build_requires
          self.run_setup()
        File "/private/var/folders/b1/frq3gywj3ljfqrf1yc7zk06r0000gn/T/pip-build-env-6kvnzo67/overlay/lib/python3.10/site-packages/setuptools/build_meta.py", line 174, in run_setup
          exec(compile(code, __file__, 'exec'), locals())
        File "setup.py", line 2, in <module>
          import versioneer
      ModuleNotFoundError: No module named 'versioneer'
      [end of output]
  
  note: This error originates from a subprocess, and is likely not a problem with pip.
error: subprocess-exited-with-error

× Getting requirements to build wheel did not run successfully.
│ exit code: 1
╰─> See above for output.

note: This error originates from a subprocess, and is likely not a problem with pip.

没有pyproject.toml一切都会恢复正常，工作正常。

该问题的发生是由于 python/setup 框架的演变，如该线程中所述：

• https://github.com/python-versioneer/python-versioneer/issues/193#issue-408237852

，在同一个线程的正下方，您将看到解决方案。

只需将"versioneer-518"添加到 pyproject 的requires中。 例如：

pyproject.toml ：

[build-system]
requires = ["setuptools>=42", "versioneer-518"]
build-backend = "setuptools.build_meta"

Answer 2

根据https://github.com/warner/python-versioneer/blob/master/INSTALL.md ，步骤取决于您的项目是通过PyPi还是通过github分发。 但是，当需要新版本时，您需要创建一个新标签。