Python: PEP 440 版本号约定指南

PEP 440（Python Enhancement Proposal 440）为Python生态系统提供了一套标准的版本号命名规则。遵循PEP 440的版本号格式不仅能提高软件包的兼容性，还能确保版本控制和依赖管理的一致性。

一、版本号的基本格式

PEP 440定义的版本号由多个部分组成，基本格式如下：

<主版本号>.<次版本号>.<修订号>[.<预发布号>|.<开发版号>|.<后发布号>]

每个部分的具体含义如下：

• 主版本号：表示重大版本更新，可能包含不兼容的API变化。
• 次版本号：表示向后兼容的功能性更新。
• 修订号：表示向后兼容的错误修复和小改动。
• 预发布号：表示还未正式发布的版本，如alpha、beta或rc（release candidate）。
• 开发版号：表示正在开发中的版本，用于标记尚未稳定的代码。
• 后发布号：用于在正式发布之后发布的紧急修复版本。

二、预发布版本（Pre-releases）

预发布版本用于在正式发布之前进行测试。预发布版本的格式如下：

<主版本号>.<次版本号>.<修订号>aN
<主版本号>.<次版本号>.<修订号>bN
<主版本号>.<次版本号>.<修订号>rcN

其中，aN表示alpha版本，bN表示beta版本，rcN表示候选发布版本。N是预发布版本的编号，从1开始递增。

三、开发版本（Developmental releases）

开发版本用于标识尚在开发中的版本，其格式如下：

<主版本号>.<次版本号>.<修订号>.devN

N是开发版本的编号，从0开始递增。例如，1.0.0.dev1表示1.0.0版本的第一个开发版本。

四、后发布版本（Post-releases）

后发布版本用于在正式发布之后发布的紧急修复版本，其格式如下：

<主版本号>.<次版本号>.<修订号>.postN

N是后发布版本的编号，从0开始递增。例如，1.0.0.post1表示1.0.0版本的第一个后发布版本。

五、本地版本（Local version identifiers）

本地版本标识用于在特定环境中进行版本区分，其格式如下：

<主版本号>.<次版本号>.<修订号>+<本地版本标识>

例如，1.0.0+local.1表示1.0.0版本的本地版本1。

六、版本比较

PEP 440还定义了版本号的比较规则，以确保版本号能够正确排序。版本比较的基本原则如下：

1. 主版本号、次版本号和修订号按数值顺序比较。
2. 预发布版本优先于正式发布版本。
3. 开发版本优先于预发布版本。
4. 后发布版本优先于开发版本。

七、实践中的应用

在实际项目中，遵循PEP 440版本号规范可以带来以下好处：

1. 依赖管理：清晰的版本号能够帮助开发者准确地管理依赖关系，避免版本冲突。
2. 版本控制：标准化的版本号有助于版本控制系统更好地识别和管理不同的版本。
3. 发布流程：使用预发布和后发布版本可以更好地规划和执行发布流程，确保发布的稳定性和可靠性。

示例

下面是几个符合PEP 440规范的版本号示例：

• 1.0.0：第一个正式发布版本。
• 1.0.1：对第一个正式版本的错误修复。
• 1.1.0：添加了新功能，但保持向后兼容。
• 2.0.0：包含不兼容的API变化。
• 1.0.0a1：第一个alpha版本。
• 1.0.0b1：第一个beta版本。
• 1.0.0rc1：第一个候选发布版本。
• 1.0.0.dev1：第一个开发版本。
• 1.0.0.post1：第一个后发布版本。

结论

PEP 440为Python项目提供了一套清晰且统一的版本号命名规则，帮助开发者更好地管理软件版本和依赖关系。在实践中，遵循PEP 440规范能够提高项目的可维护性和稳定性，是每个Python开发者都应该掌握的重要内容。