如何在Python中通过setuptools_scm根据Git标签自动生成版本号?

胖芳大大_1186

胖芳大大_1186

2026-08-21

741人浏览

原创

setuptools_scm能从git标签生成版本号,但要求项目根目录有.git且已打符合语义化规范的tag(如v1.2.3),否则fallback为dev格式;需在pyproject.toml中正确配置build-system和project.dynamic=["version"],并确保ci获取完整git历史。

如何在python中通过setuptools_scm根据git标签自动生成版本号?

直接用 setuptools_scm 就能从 Git 标签生成版本号,但前提是你的项目根目录有 .git,且已打过符合语义化规范的 tag(如 v1.2.3)。否则它会 fallback 到“未发布”格式(如 0.1.0.dev1+gabc1234),不是你想要的稳定版号。

确保 Git 仓库状态满足 setuptools_scm 要求

setuptools_scm 不读 setup.py 或 pyproject.toml 以外的任何元数据,它只依赖 Git 历史。常见失败原因不是配置错,而是仓库本身不达标:

  • 项目目录必须是 Git 工作区根目录(即运行 git rev-parse --show-toplevel 应返回当前路径)
  • 最近一次 commit 必须有 tag,且 tag 名要匹配默认正则 ^v?(\d+\.\d+\.\d+)$(比如 v1.2.3 或 1.2.3 都行,release-1.2.3 就不行)
  • 如果没 tag,它会按距离最近 tag 的提交数 + 当前 commit hash 构造 dev 版本,这不是 bug,是设计行为

在 pyproject.toml 中启用 setuptools_scm

现代 Python 项目应使用 pyproject.toml,而不是旧式 setup.py。关键配置只有两处,别多写:

[build-system]
requires = ["setuptools>=45", "setuptools_scm[toml]>=6.2"]
build-backend = "setuptools.build_meta"
<p>[project]
name = "mylib"</p><h1>不要写 version 字段!交给 setuptools_scm 动态生成</h1><p>dynamic = ["version"]</p><p>[project.optional-dependencies]
dev = ["setuptools_scm"]</p><p>[tool.setuptools_scm]</p><div class="aritcle_card flexRow artxards">
											<div class="artcardd flexRow">
												<a class="aritcle_card_img" rel="nofollow" href="/xiazai/skill6081" title="python-code-analyz"><img
														src="https://img.php.cn/upload/skill/000/000/081/179077148379011.jpg" alt="python-code-analyz" onerror="this.onerror='';this.src='/static/lhimages/moren/morentu.png'" ></a>
												<div class="aritcle_card_info flexColumn">
													<a rel="nofollow" href="/xiazai/skill6081" title="python-code-analyz" class="overflowclass">python-code-analyz</a>
													<p class="overflowclass">专业Python代码分析与优化,支持语法检查、安全扫描、性能评估、复杂度分析及重构后优化代码生成。</p>
												</div>
												<a rel="nofollow" href="/xiazai/skill6081" title="python-code-analyz" class="aritcle_card_btn flexRow flexcenter"><b></b><span>下载</span>
												</a>
											</div>
										</div><h1>可选:放宽 tag 匹配规则(例如支持 'v1.2.3-beta.1')</h1><h1>version_scheme = "guess-next-dev"</h1><h1>local_scheme = "node-and-date"</h1>

注意:dynamic = ["version"] 是必需的,否则 setuptools 会忽略 setuptools_scm 的注入;requires 里必须显式包含 setuptools_scm[toml],否则 toml 解析器可能缺失。

验证版本号是否真被正确读取

别靠 pip install -e . 后 import 看 __version__ —— 这个值可能来自源码里硬编码的 fallback,而非 Git。真正可靠的验证方式是:

  • 运行 python -m setuptools_scm:它会直接输出当前解析出的版本字符串,且附带调试信息(如 “tag ‘v1.2.3’ found” 或 “no tag found”)
  • 构建 sdist/wheel 后解压,检查生成的 PKG-INFO 或 mylib-*.dist-info/METADATA 里的 Version: 字段
  • 在干净虚拟环境中 pip install ./dist/mylib-*.tar.gz,再 import mylib; print(mylib.__version__)

如果 python -m setuptools_scm 输出的是 0.0.0,说明它根本没找到 Git 信息——大概率是当前路径不在 Git 仓库内,或 .git 被误删/忽略。

最常被忽略的一点:CI 环境中 clone 的仓库默认是 shallow(--depth=1),没有完整历史和 tag。必须显式加 git fetch --tags --prune 或设置 fetch-depth: 0(GitHub Actions)才能让 setuptools_scm 正常工作。

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

相关文章

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

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

下载

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

相关专题

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

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

2023.07.20

1651

4

python能做什么
python能做什么

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

2023.07.25

4064

7

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

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

2023.07.31

1649

3

python教程
python教程

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

2023.08.03

23517

23

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

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

2023.08.04

2887

5

python eval
python eval

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

2023.08.04

2907

5

scratch和python区别
scratch和python区别

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

2023.08.11

1143

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2263

5

热门下载

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

精品课程

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