Python 高手编程系列一百一十三：用于保持跨版本兼容性的常用工具和技术

在 Python 不同版本之间保持兼容性是一项挑战。根据项目的大小不同，这项挑战可能
会增加许多额外的工作量，但绝对可行，也很值得去做。对于在许多环境中都会用到的
Python 包来说，必须要保持跨版本兼容性。如果开源包没有定义明确并经过测试的兼容范
围（compatibility bound），是不太可能流行起来的。而且，对于只在公司网络封闭使用的第
三方代码来说，也可以大大受益于在不同环境中的测试。
这里应该注意，虽然这一部分内容主要关注 Python 不同版本之间的兼容，但这些方法
也适用于保持与外部依赖项之间的兼容，外部依赖项包括不同的包版本、二进制库、系统
或外部服务等。
整个过程主要分为 3 个部分，按重要性排序如下。
• 定义并记录目标兼容范围的及其管理方法。
• 在每个环境中进行测试，并对每个兼容的依赖版本进行测试。
• 实现实际的兼容代码。
告知兼容范围是整个过程中最重要的一部分，因为这可以让代码使用者（开发人员）
对代码的工作原理和未来的变化方式有一定的预期和假设。我们的代码可能用于多个不同
项目的依赖，这些项目也在努力管理兼容性，所以把代码兼容性说清楚还是很重要的。
本书总是尽量给出几个选择，而不会强烈推荐某个特定选项，而这里是少数几个例外之一。
目前来看，管理兼容性未来变化的最佳方法，就是正确使用语义化版本（Semantic Versioning
semver）的版本号。它是一个广为接受的标准，用仅包含 3 个数字的版本标识符来标记代码的
变化范围。它还给出了如何处理弃用的方法建议。下面是摘录 semver 官网的摘要。
版本格式：主版本号.次版本号.修订号，版本号递增规则如下。
• 主版本号（MAJOR）：当你做了不兼容的 API 修改。
• 次版本号（MINOR）：当你做了向后兼容的功能性新增。
• 修订号（PATCH）：当你做了向后兼容的问题修正。
先行版本号及版本编译信息可以加到“主版本号.次版本号.修订号”的后面，作为延伸。
测试时就会发现一个悲伤的事实，为了保证代码与每个依赖版本和每个环境（这里环
境指的是 Python 版本）都保持兼容，必须在所有可能的组合中对代码进行测试。当然，如
果项目的依赖很多，做到这一点基本是不可能的，因为随着依赖版本数目的增加，组合的
数目也会迅速增加。因此，通常需要做一些权衡，使得运行所有兼容性测试无需花费数年
的时间。第 10 章中介绍一般的测试，里面也介绍了所谓的矩阵测试中工具的选择。
如果明确定义了兼容范围并严格测试，那么实现兼容层就是最后一步，也是最不重要
的一步。但是，每一位对这个话题感兴趣的程序员都应该知道下列工具和技术。
最基本的就是 Python 的__future__模块。它将 Python 新版本中的一些功能反向迁移
到旧版本中，采用的是导入语句的形式：
from future import
future 语句提供的功能是和语法相关的元素，其他方法很难处理这些元素。这个语句只
能影响它所在的模块。下面是Python 2.7 交互式会话的实例，从Python 3.0 中引入Unicode：
Python 2.7.10 (default, May 23 2015, 09:40:32) [MSC v.1500 32 bit
(Intel)] on win32
Type “help”, “copyright”, “credits” or “license” for more
information.

type(“foo”) # 旧的字面值
<type ‘str’>
from _future __ import unicode _literals
type(“foo”) # 现在变成了 unicode
<type ‘unicode’>
下面列出了所有可用的__future__语句，关注 2/3 兼容性的开发者都应该知道。
• division：Python 3 新增的除法运算符（PEP 238）。
• absolute_import：将所有不以点字符开头的 import 语句格式解释为绝对导入
（PEP 328）。
• print_function：将 print 语句变为函数调用，所以在 print 后面必须加括
号（PEP 3112）。
• unicode_literals：将每个字符串解释为 Unicode（PEP 3112）。
__future__中的可选语句列表很短，只包含几个语法功能。对于其他变化的内容，例如元
类语法（第 3 章会讲到这一高级特性），维持其兼容性则困难得多。future 语句也无法完全解
决多个标准库重组的问题。幸运的是，有些工具旨在提供一致可用的兼容层。最有名的就是Six
模块，提供了常用的2/3 兼容性的整个样板。另一个很有前途但名气稍逊的工具是future 模块。
在某些情况下，开发人员可能不想在一些小型 Python 包里添加其他依赖项。通常的
做法是将所有兼容性代码放在一个附加模块中，该模块通常命名为 compat.py。下面是
来自 python-gmaps 项目的 compat 模块实例：

-- coding: utf-8 --

import sys
if sys.version_info < (3, 0, 0):
import urlparse # noqa
def is_string(s):
return isinstance(s, basestring)
else:
from urllib import parse as urlparse # noqa
def is_string(s):
return isinstance(s, str)
这样的 compat.py 模块十分常见，即使是利用 Six 保持 2/3 兼容性的项目也很常见，
因为这种方法非常方便，用于保存在不同版本的依赖包之间保持兼容性的代码。