如何使用setuptools-scm自动从Git标签生成Python包版本号

酷雪小哥_9696

酷雪小哥_9696

2026-10-03

550人浏览

原创

最稳妥的方式是用 setuptools-scm 实时从 git 标签和提交历史推导版本号,要求仓库为有效 git 仓库、含 pep 440 兼容的附注标签,且 pyproject.toml 正确配置 build-backend 和 tool.setuptools-scm。

如何使用setuptools-scm自动从git标签生成python包版本号

直接用 setuptools-scm 是最稳妥的方式——它不碰 __version__ 字符串,也不依赖手动维护 setup.py 里的版本字段,而是实时从 Git 提交历史和标签里推导版本号。前提是你的仓库必须是有效的 Git 仓库,且有符合 PEP 440 的标签(如 v2.1.0、2.1.0)。

确保 Git 仓库结构满足 setuptools-scm 要求

它只读取工作目录下的 .git 目录,不会走远程或子模块。常见失败原因不是配置错,而是 Git 状态不对:

  • 项目根目录下没有 .git(比如用 cp -r 复制源码但没带 .git)
  • 当前分支没关联任何远程,但你又启用了 write_to 或 local_scheme 中依赖远程的逻辑(如 node-and-date)
  • 最近的 tag 是轻量 tag(lightweight tag),不是附注 tag(annotated tag)——setuptools-scm 默认只信任附注 tag,除非显式设 fallback_version 或改 version_scheme
  • Git 工作区有未提交变更,而你用了 dirty=True(默认开启),会导致版本号末尾自动加 +dYYYYMMDD 或 .dirty,CI 环境中可能意外触发

在 pyproject.toml 中正确启用 setuptools-scm

不再推荐用 setup.py,现代方式是纯 pyproject.toml 配置。关键点在于:必须声明 build-backend 并启用插件,否则 pip install -e . 或 build 时根本不会调用它:

[build-system]
requires = ["setuptools>=45", "setuptools-scm[toml]>=6.2", "wheel"]
build-backend = "setuptools.build_meta"
<p>[project]
name = "mylib"</p><h1>不要写 version = "1.0.0" —— 这会覆盖 setuptools-scm 的自动推导!</h1><p>[tool.setuptools-scm]</p><h1>常用配置项</h1><p>version_scheme = "guess-next-dev"
local_scheme = "dirty-tag"
write_to = "mylib/_version.py"</p>

注意:write_to 是可选的,仅当你需要在运行时读取版本(如 mylib.__version__)才设;如果只用于构建分发包(sdist/wheel),完全可以不写。

GitHub Iteration Workflow
GitHub Iteration Workflow

GitHub Issue 全流程自动化:自动拉取、修复 Issue,创建 PR,监控 CI/CD,合并部署。

下载

处理 dev 版本与预发布标签的常见行为

如果你打过 v2.1.0a1 或 v2.1.0rc2 这类预发布 tag,setuptools-scm 默认会生成类似 2.1.0a1.dev3+gabc123 的版本号。但容易踩坑的是:

  • version_scheme = "guess-next-dev"(默认)会在最新 tag 后自动升 patch 并加 .devN,比如最新 tag 是 v2.1.0,当前 HEAD 比它多 3 次提交 → 版本为 2.1.1.dev3;若想保持 2.1.0.dev3,得用 no-guess-dev
  • 如果你用 git describe --tags 手动验证,结果可能和 setuptools-scm 不一致——因为它默认忽略轻量 tag,而 git describe 默认包含;可用 git describe --tags --abbrev=0 对齐逻辑
  • CI 构建时若用 shallow clone(git clone --depth=1),setuptools-scm 会 fallback 到 fallback_version(需手动配置),否则报错 Command 'git' failed with exit code 128

验证版本是否真正生效

别只信 python -m build 输出的日志。最可靠的验证方式是实际安装后检查:

pip install -e .
python -c "import mylib; print(mylib.__version__)"

如果报 AttributeError: module 'mylib' has no attribute '__version__',说明要么没设 write_to,要么 write_to 路径没被 __init__.py 导入;如果输出是 0.0.0,大概率是 Git 根目录识别失败,或者最近没有合法 tag——此时运行 python -m setuptools_scm(在项目根目录)能直接打印诊断信息,包括它找到的 tag、距离、是否 dirty 等。

真正麻烦的永远不是配置本身,而是 Git 历史的“干净程度”:tag 是否附注、HEAD 是否在 tag 上、是否有 untracked 文件影响 dirty 判断。这些细节不暴露在配置里,却决定最终版本号是否符合预期。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python git python包

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1631

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4004

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1629

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

23137

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2847

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2867

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1123

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2223

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程