兼容层

相关源文件

• test/swftests/ConstArrayAccess.as
• test/swftests/ConstantInt.as
• test/swftests/DictCall.as
• test/test_compat.py
• test/test_swfinterp.py
• youtube_dl/compat.py
• youtube_dl/extractor/openload.py
• youtube_dl/extractor/rtve.py
• youtube_dl/postprocessor/embedthumbnail.py
• youtube_dl/socks.py
• youtube_dl/swfinterp.py

youtube-dl 中的兼容性层提供了跨 Python 版本兼容性，确保代码库能在 Python 2.x 和 3.x 环境中无缝工作。该模块抽象了标准库模块、函数和行为中的版本特定差异，使代码库的其他部分能够以版本无关的方式运行。

目的和设计

兼容性层充当了不同 Python 版本之间的桥梁，主要针对 Python 2 到 Python 3 的过渡。它遵循源代码注释中提到的命名约定：compat_ + Python3_name.replace('.', '_')。这使得开发人员可以在整个代码库中使用一致的导入，同时保持与两个 Python 版本的兼容性。

图示：youtube-dl 架构中的兼容性层

来源：youtube_dl/compat.py1-35

关键组件和功能

兼容性层实现了几类兼容性功能：

1. 基本字符串和字符类型：对 str、basestring、chr 及其他字符串相关函数提供兼容性。
2. 标准库模块兼容性：对 urllib、http.cookiejar 和 html.entities 等模块提供封装。
3. 结构化数据类型：对集合和其他数据结构提供兼容性。
4. 二进制数据处理：用于编码/解码和二进制数据操作的函数。

图示：兼容性层组件

来源：youtube_dl/compat.py35-146

字符串和 Unicode 处理

Python 2 和 Python 3 之间的一个主要区别是字符串处理。兼容性层提供了：

• compat_str：在 Python 2 中映射到 unicode，在 Python 3 中映射到 str
• compat_basestring：在 Python 2 中映射到 basestring，在 Python 3 中映射到 (str, bytes)
• compat_chr：在 Python 2 中映射到 unichr，在 Python 3 中映射到 chr
• compat_casefold：跨版本兼容的字符串大小写折叠操作

来源：youtube_dl/compat.py34-43 test/test_compat.py127-137

URL 处理

URL 处理在 Python 2（urllib2）和 Python 3（urllib.request）之间存在显著差异。兼容性层提供了：

• compat_urllib_request：URL 请求功能
• compat_urllib_error：URL 错误处理
• compat_urllib_parse：URL 解析
• compat_urllib_response：响应处理

此外，它还通过添加 Request 中的 method 参数等缺失功能来扩展其功能。

来源：youtube_dl/compat.py61-89 test/test_compat.py139-150

HTTP 和 Cookie 处理

HTTP 和 Cookie 处理包括：

• compat_http_cookiejar：Cookie 存储功能
• compat_cookiejar_Cookie：具有兼容性改进的 Cookie 类
• compat_http_cookies：HTTP Cookie 功能
• compat_cookies_SimpleCookie：增强的 Cookie 处理

来源：youtube_dl/compat.py129-178 youtube_dl/extractor/openload.py25-49

HTML 实体处理

HTML 实体处理包括：

• compat_html_entities：实体定义
• compat_html_entities_html5：HTML5 特定的实体定义

来源：youtube_dl/compat.py181-1223

结构化和实用函数

提供了一些结构化和实用函数：

• compat_struct_unpack：用于二进制数据解包
• compat_b64decode：用于 base64 解码
• 文件和环境变量处理

来源：youtube_dl/swfinterp.py7-10 youtube_dl/extractor/rtve.py10-13

使用模式

兼容性层旨在根据需要直接导入。常见的导入模式包括：

或

这种方法使代码库能够使用 Python 3 风格的代码，同时保持 Python 2 的兼容性。

下表显示了一些最常用的兼容性组件：

组件	Python 2	Python 3	目的
compat_str	unicode	str	字符串类型
compat_urllib_request	urllib2	urllib.request	URL 处理
compat_http_cookiejar	cookielib	http.cookiejar	Cookie处理
compat_struct_unpack	struct.unpack	struct.unpack	二进制数据解包
compat_open	自定义封装	open	支持编码的文件打开

来源：youtube_dl/extractor/openload.py9-12 youtube_dl/postprocessor/embedthumbnail.py21

实现细节

Python 版本检测

兼容性层使用 try/except 块来检测 Python 版本并导入相应的模块。

该模式在整个模块中使用，以处理不同的 Python 版本。

扩展和增强

在某些情况下，兼容性层不仅提供兼容性，还增强了功能。例如，compat_urllib_request 中的 Request 类被扩展以支持 method 参数，该参数在 Python 2 中缺失。

图示：兼容性层中 Request 类的增强

来源：youtube_dl/compat.py67-88

测试

兼容性层在测试套件中有专门的测试来验证其在不同 Python 版本上的功能。这些测试确保：

1. 基本字符串操作一致工作。
2. URL 解析函数按预期运行。
3. HTTP 和 Cookie 处理保持兼容性。
4. 解包二进制数据等结构化操作正确工作。

例如，compat_urllib_parse_unquote 的测试确保了 URL 解码对 Unicode 字符的正确处理。

来源：test/test_compat.py59-76

与其他系统集成

兼容性层与 youtube-dl 代码库中的各种其他系统集成：

1. 提取器：用于 URL 处理和 HTML 处理。
2. SWF 解释器：用于二进制数据处理。
3. 后处理器：用于文件操作和编码。

例如，SWF 解释器依赖 compat_struct_unpack 进行二进制数据提取。

来源：youtube_dl/swfinterp.py100-111

结论

兼容性层是 youtube-dl 的一个关键组成部分，它使代码库能够在 Python 2.x 和 3.x 环境中无缝工作。通过抽象版本特定的差异，它使开发人员能够在整个项目中编写干净、版本无关的代码。随着时间的推移，对 Python 2 的支持变得不再那么重要，该层还提供了一种结构化的方式来逐渐淘汰兼容性代码，同时为代码库的其余部分维护一致的 API。