如何在Python项目中使用setuptools-scm自动管理版本号

千静同学_8061

千静同学_8061

2026-09-15

295人浏览

原创

setuptools-scm 可行但要求项目为含规范 tag 的 Git 仓库,否则静默返回 0.0.0;硬编码 version 导致发布遗漏、CI 版本混淆、tag 与源码不一致;其核心是从 Git 历史推导版本,需禁用 version 字段、配置 pyproject.toml 并确保 Git 状态有效。

如何在python项目中使用setuptools-scm自动管理版本号

直接用 setuptools-scm 是可行的,但前提是你的项目必须是 Git 仓库且有规范的 tag —— 否则它根本不会生成版本号,也不会报错,只会静默回退到 0.0.0。

为什么 setup.py 里写死 version="1.2.3" 是反模式

硬编码版本号会导致三类典型问题:发布后忘记改 setup.py、CI 构建时无法区分本地开发版和正式发布版、Git tag 和源码版本不一致。而 setuptools-scm 的核心逻辑是「从 Git 提交历史推导版本」,不是读文件,所以它天然适配自动化流程。

常见错误现象:pip install -e . 后 import mypkg; mypkg.__version__ 返回 '0.0.0' —— 这几乎 100% 是因为当前目录不是 Git 工作区,或最近没有打过 tag。

  • 确保项目根目录存在 .git 目录(不是子目录)
  • 至少打过一个符合 PEP 440 的 tag,例如 git tag v0.1.0(注意 v 前缀是默认规则)
  • 不要在 setup.py 或 pyproject.toml 中再写 version=... 字段,否则会覆盖 setuptools-scm 的计算结果

pyproject.toml 配置要点(推荐方式)

setup.py 已被弃用,pyproject.toml 是唯一正统入口。关键配置项只有三个,多写反而容易出错:

[build-system]
requires = ["setuptools>=45", "wheel", "setuptools-scm[toml]>=6.2"]
build-backend = "setuptools.build_meta"
<p>[project]
name = "mypkg"</p><h1>不要写 version!让 setuptools-scm 接管</h1><p>[tool.setuptools-scm]
write_to = "mypkg/_version.py"</p>

说明:write_to 不是必须项,但强烈建议启用——它会在构建时把计算出的版本字符串写入指定 Python 文件,方便运行时导入;路径必须是包内有效模块路径,且该文件不能预先存在(否则会被覆盖)。

Python健壮编程
Python健壮编程

编写可靠Python代码,避免可变默认值、导入陷阱与运行时意外

下载
  • 如果不用 write_to,只能通过 importlib.metadata.version("mypkg") 获取版本,这对 Python importlib-metadata
  • 默认 tag 正则为 r'^v(?P[^+]+)(?P.*)?$',想匹配 1.2.3 而非 v1.2.3?加一行 version_scheme = "guess-next-dev" 并设 tag_regex = r'^(?P[^+]+)(?P.*)?$'
  • 开发中频繁提交但没打 tag,默认版本形如 0.1.0.dev1+gabc123,其中 dev1 表示距上次 tag 差 1 个提交,gabc123 是短 commit hash

验证是否生效的最快方法

别等打包完再测,两步就能确认逻辑通不通:

  • 终端执行 python -m setuptools_scm —— 它会尝试读取当前目录的 Git 状态并打印推导出的版本,失败时会明确提示原因(比如 No tag found)
  • 执行 pip install -e ".[dev]"(假设你定义了 dev extras),然后在 Python 里运行 from importlib.metadata import version; print(version("mypkg"))

注意:如果项目使用 src/ 布局(即源码在 src/mypkg/ 下),write_to 路径必须对应为 "src/mypkg/_version.py",否则安装后模块里找不到该文件。

最容易被忽略的是 Git 子模块和浅克隆 —— setuptools-scm 默认不递归进子模块,CI 中用 git clone --depth=1 会导致无法获取历史 tag。真要用浅克隆,得显式加 --tags 参数或配置 git fetch --prune --unshallow --tags。

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

相关文章

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

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

下载

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

相关专题

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

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

2023.07.20

1951

4

python能做什么
python能做什么

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

2023.07.25

5544

7

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

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

2023.07.31

1889

3

python教程
python教程

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

2023.08.03

33897

23

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

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

2023.08.04

3967

5

python eval
python eval

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

2023.08.04

3987

5

scratch和python区别
scratch和python区别

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

2023.08.11

1283

5

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

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

2023.08.10

636

4

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

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

2023.08.11

3083

5

热门下载

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

精品课程

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