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

直接用 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 文件,方便运行时导入;路径必须是包内有效模块路径,且该文件不能预先存在(否则会被覆盖)。
- 如果不用
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]"(假设你定义了devextras),然后在 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 的核心概念和高级技巧!











