Python项目开发者怎么给自己的开源核心库添加遵循规范的版本号?

秋明君_7879

秋明君_7879

2026-10-31

779人浏览

原创

版本号必须写在包的顶层 __init__.py 或专用 _version.py 中,且严格符合 PEP 440 格式,确保运行时、构建时和依赖解析一致。

python项目开发者怎么给自己的开源核心库添加遵循规范的版本号?

version 必须出现在包的顶层 init.py 或专用 _version.py 中,且格式要严格符合 PEP 440 —— 否则 pip install、twine upload 和依赖解析都会出问题。

版本号必须写在哪儿?不是随便放个变量就行

Python 包的版本号不能只存在文档或 README 里,运行时和构建时都要能被可靠读取。最稳妥的位置只有两个:

  • myproject/__init__.py:直接定义 __version__ = "1.2.3",适合小项目;导入包时立即可用(import myproject; myproject.__version__)
  • myproject/_version.py:单独文件,只含版本定义和可选的 version_info 元组,避免 __init__.py 因导入副作用导致循环依赖或提前失败

注意:setup.py 或 setup.cfg 里的 version 字段已过时;pyproject.toml 中的 [project].version 是构建时读取的“权威源”,但它必须和运行时实际暴露的 __version__ 值一致,否则用户 import 后看到的版本和 pip show 显示的不一致,会引发信任问题。

PEP 440 格式不是“差不多就行”,错一位就上传失败

常见错误是写成 "v1.2.3"、"1.2.3-beta" 或 "1.2.3+git" —— 这些都不合法。正确格式必须满足:

  • 主次修订号全为数字:"1.2.3" ✔️,"1.2.x" ❌
  • 预发布后缀用 a/b/rc:"1.2.3a1" ✔️,"1.2.3-alpha" ❌
  • 本地版本用 + 号分隔,但仅限构建时临时标记:"1.2.3+local" ✔️(PyPI 接受但忽略 + 后内容),"1.2.3-dev" ❌(未加 + 就是非法预发布)
  • 构建工具如 build 或 poetry 会在打包前校验该字符串,不合规直接报错:InvalidVersion: "1.2.3-beta" is not a valid PEP 440 version

动态版本号(如 git 描述)要慎用,别让 CI 卡在 git describe 上

想自动从 git tag 生成版本(比如 git describe --tags --always 输出 1.2.3-5-gabc123),可以,但得绕过两个坑:

macOS UI 自动化技能包 —— 用 Python 控制你的 Mac
macOS UI 自动化技能包 —— 用 Python 控制你的 Mac

让 macOS 自动化像说话一样简单 —— 用代码控制你的 Mac,无需学习 AppleScript 系统要求 macOS 14+ (Sonoma) Python 3.9+ 需要开启:辅助功能 + 屏幕录制权限

下载
  • 本地开发时没打 tag,git describe 直接失败 → 改用 git rev-parse --short HEAD 作 fallback,并加 +dirty 标记未提交修改
  • CI 环境(如 GitHub Actions)默认只 fetch 最新 commit,不带 tag → 在 workflow 中显式加 fetch-depth: 0 或 git fetch --prune --unshallow
  • 最终拼出的字符串仍需通过 packaging.version.Version 校验,不能直接塞进 __version__;推荐用 setuptools_scm,它内置了这些逻辑,且与 pyproject.toml 集成简单

多语言混合项目(如含 C++ 扩展)必须双侧同步

像 pybind11 这类项目,C++ 头文件里的宏(PYBIND11_VERSION_MAJOR)和 Python 的 __version__ 必须完全一致。构建 wheel 时,setup.py 会读取两者并比对 —— 不一致就中断,报错信息类似:

ValueError: C++ PYBIND11_VERSION_* macros (2.13.1) do not match Python __version__ ('2.13.0')

这意味着你改了 Python 侧版本却忘了更新 C++ 宏,或者反过来。自动化手段有限,最靠谱的做法是:

  • 把三处版本来源(C++ 头、_version.py、pyproject.toml)列在 README 的“发布检查清单”里
  • 加一个 pre-commit hook 或 CI step,用正则提取所有位置的版本字符串并断言相等
  • 别依赖脚本自动生成 —— 自动生成容易漏掉某一处,而人工核对三行文本反而更可靠

版本号看着只是几个数字,但它是整个分发链路的锚点:用户靠它判断兼容性,工具靠它解析依赖,CI 靠它触发发布流程。写错位置、格式越界、多端不同步,任何一个环节松动,下游就会收到“安装成功但 import 失败”或“pip show 版本和代码里 print 出来的不一样”这类让人半夜爬起来查的日志。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1831

4

python能做什么
python能做什么

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

2023.07.25

4944

7

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

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

2023.07.31

1789

3

python教程
python教程

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

2023.08.03

29677

23

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

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

2023.08.04

3547

5

python eval
python eval

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

2023.08.04

3547

5

scratch和python区别
scratch和python区别

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

2023.08.11

1223

5

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

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

2023.08.10

616

4

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

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

2023.08.11

2763

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习