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

P粉602998670

P粉602998670

2026-06-17

641人浏览

原创

setup.py硬编码版本号易导致版本与git标签脱节,引发包安装版本错误及ci构建不一致;应删去version字段,改用setuptools-scm动态提取git标签生成pep 440兼容版本,如1.2.0.dev3+gabc123d。

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

为什么 setup.py 里写死版本号会出问题?

手动维护 __version__setup.py 中的 version="1.2.3",很容易和 Git 标签脱节。比如打了 v2.0.0 标签,但代码里还是 "1.9.9"pip install . 装出来的包版本就错。更麻烦的是,CI 构建时如果依赖本地文件版本,不同分支、不同提交构建结果可能不一致。

如何让 setuptools_scm 从 Git 提取真实版本?

核心是删掉 setup.pypyproject.toml 里的硬编码 version 字段,改用 setuptools_scm 动态生成。它默认读取最近 tag(如 v1.2.0),再根据距该 tag 的提交数、是否 dirty 等信息拼出类似 1.2.0.dev3+gabc123d 的开发版版本。

  • 确保项目根目录有 Git 仓库,且已打过至少一个符合语义化格式的 tag(如 v1.0.01.2.0
  • pyproject.toml 中启用:
    [build-system]
    requires = ["setuptools>=45", "wheel", "setuptools_scm[toml]>=6.2"]
    build-backend = "setuptools.build_meta"
    <p>[project]</p><h1>删除 version = "x.y.z" 这一行</h1><p>dynamic = ["version"]</p><div class="aritcle_card flexRow artxards">
    											<div class="artcardd flexRow">
    												<a class="aritcle_card_img" rel="nofollow" href="/xiazai/gongju/2506" title="Python 3.14.2"><img
    														src="https://img.php.cn/upload/manual/001/221/864/6a696c31dfa4a111.webp" alt="Python 3.14.2" onerror="this.onerror='';this.src='/static/lhimages/moren/morentu.png'" ></a>
    												<div class="aritcle_card_info flexColumn">
    													<a rel="nofollow" href="/xiazai/gongju/2506" title="Python 3.14.2" class="overflowclass">Python 3.14.2</a>
    													<p class="overflowclass">Python 3.14.2是Python编程语言在2025年12月5日发布的稳定版本,属于3.14系列的第二个维护更新。该版本包含了18项修复,重点解决了多进程、数据类及正则表达式等模块的回归问题,并修复了CVE-2025-12084等安全漏洞。此版本标志着自由线程模式(移除GIL)正式获得官方支持,是Python发展的重要里程碑。</p>
    												</div>
    												<a rel="nofollow" href="/xiazai/gongju/2506" title="Python 3.14.2" class="aritcle_card_btn flexRow flexcenter"><b></b><span>下载</span>
    												</a>
    											</div>
    										</div><p>[project.scm]
    write_to = "src/mypackage/_version.py"</p>
  • 如果不用 pyproject.toml,而用 setup.py,则需加 use_scm_version=True 参数,并确保 setup.py 同级有 pyproject.tomlsetup.cfg 声明依赖

setuptools_scm 版本格式怎么控制?

默认格式对 CI 和 PyPI 友好,但有时需要微调:比如去掉 dev 分支标识、强制使用 PEP 440 兼容格式、或忽略 dirty 状态。这些靠 pyproject.toml 中的 [tool.setuptools_scm] 配置。

  • version_scheme = "post-release":把 1.2.0.dev3 变成 1.2.0.post3,适合发布候选
  • local_scheme = "no-local":禁用 +gabc123d 这类本地哈希后缀,只保留主版本
  • fallback_version = "0.1.0":当不在 Git 仓库中(如 tarball 解压后)时的兜底版本
  • 若 tag 是 1.2.0-rc1,默认会解析为 1.2.0rc1;想支持破折号分隔符,需加 git_describe_command = "git describe --dirty --tags --long --match 'v*'"

常见错误:安装时报 LookupError: setuptools-scm was unable to detect version

这通常不是配置错,而是环境缺失关键信息:

  • 当前目录不在 Git 工作区(.git 文件夹丢失或路径不对)
  • Git 仓库没提交过任何东西(空仓库无 commit,自然无 tag)
  • 打了 tag 但没 push 到远程,而 CI 拉的是 shallow clone(需在 CI 中加 git fetch --prune --unshallow--depth=0
  • 用了 submodule,但主项目没初始化子模块,导致 git describe 失败
  • Windows 上路径含中文或空格,某些旧版 setuptools_scm 会解析失败,升级到 8.0+ 可缓解

调试时直接运行 python -m setuptools_scm,它会模拟构建过程并打印详细原因。

真正难搞的是混合工作流:比如主干用 v1.2.0,但某特性分支想基于 v1.2.0-rc2 打 patch,这时 tag 命名规则和 version_scheme 必须对齐,否则生成的版本号既不能排序也无法被 pip 正确比较。

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

相关专题

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

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

2023.07.20

1104

4

python能做什么
python能做什么

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

2023.07.25

2070

7

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

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

2023.07.31

1185

3

python教程
python教程

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

2023.08.03

8753

23

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

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

2023.08.04

1478

5

python eval
python eval

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

2023.08.04

1530

5

scratch和python区别
scratch和python区别

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

2023.08.11

880

5

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

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

2023.08.10

530

4

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

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

2023.08.11

1111

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PyCharm官方快速入门指南
PyCharm官方快速入门指南

共0课时 | 0人学习

Python函数定义官方教程
Python函数定义官方教程

共0课时 | 0人学习

Python 3.14.6官方文档
Python 3.14.6官方文档

共0课时 | 0人学习